Skip to main content

Edit or Change an API

What​

Edit or change an existing API. Specific team members can edit or change APIs.

  • NOT Session-specific—Editing an API, is not session-specific. Edits, changes to an API remain unless and until the API is edited again or deliberately deleted.
  • NOT User-specific—The APIs are visible to all of your company’s team members who access APIs in PortX.
  • Confirmation message—A system confirmation message DOES appear in the upper right of the page, to show successful completion of the editing of an API.

Where​

Where is an API edited or changed? Editing an API is initiated on the API Catalog Page, then the details are entered in the Edit API page.

When​

When should APIs be edited or changed? As needed to meet your company’s business needs.

Who​

Who should edit APIs? The Team Members to whom your company has granted permission and authorized to edit or change APIs.

Why​

Why edit APIs? Edit them as needed for your company’s business needs.

How​

How to edit or change an existing API? Instructions and screen captures are provided here in this section of the PortX Platform documentation.



Figure 19. Select the API to Edit

Figure 19. Select the API to Edit



Find the API you want to edit. Click on the Open button as shown in Figure 19.

The Edit API page opens as shown in Figure 20.



Figure 20. Edit API Components and Details

Figure 20. Edit API Components and Details



Edit any of the following information that is editable (provisioning cannot be added in an edit), if you need to change any of the content (6 fields in the 1st column):

  • ID—not editable—is at least 5 characters
    • Name is unique and follows the same rules as a GitHub repo
  • Label—required—editable—maximum 20 characters
  • Description—required—editable
  • OpenApi Specification—autogenerated and is editable
    • By default this points to a certain folder but is editable in case you want to put it somewhere else
    • Swagger file
  • API Documentation Site—not editable
  • ECR Repository—not editable
    • Container registry
    • You had the option of editing this field when creating the API in case you have your own build process

Continue editing any of the following information that is editable, if you need to change any of the content in the following information (6 fields in the 2nd column)

  • Tags
  • GitOps Repository—autogenerated and is editable
  • Charts Repository—autogenerated and is editable
  • Code Repository—autogenerated and is editable
  • API Documentation Repository—autogenerated and is editable
  • API Template—not editable
    • Framework templates, or they can be pre-built such as actual code, or a starting point for an application
    • One of the following choices:
      • Camel/Quarkus—Native compiling that makes the container start faster with less memory and behaves better in Kubernates. Kubernates restarts and moves things around so the faster it is, the better it is.
      • Camel/Springboot
      • Default—blank GitHub default repo with no code
      • Karavan—low code tool for visual designer
      • Account Opening Flow—one of the common scenarios that financial institutions use
      • Karavan Common—a Karavan template

Save your changes.

Click on Save.

A confirmation message briefly appears in the upper right corner of the page, confirming the successful completion of edits, changes to the API.

The edits to the API may take a few minutes to appear in the API Catalog.